/**
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a
 * copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.jasig.portal.events.aggr;

import org.joda.time.DateTime;

/**
 * Bean that tracks the status of portal event aggregator work.
 * 
 * @author Eric Dalquist
 * @version $Revision$
 */
public interface IEventAggregatorStatus {
    /**
     * Types of aggregator processing
     */
    public enum ProcessingType {
        /**
         * Event aggregation processing
         */
        AGGREGATION,
        /**
         * Event purging processing
         */
        PURGING,
        /**
         * Unclosed aggregation cleanup
         */
        CLEAN_UNCLOSED;
    }
    
    /**
     * @return Type of processing that was done
     */
    ProcessingType getProcessingType();
    
    /**
     * @return Server name that last ran the processing
     */
    String getServerName();
    void setServerName(String serverName);
    
    /**
     * @return Processing start DateTime
     */
    DateTime getLastStart();
    void setLastStart(DateTime lastStart);
    
    /**
     * @return Processing complete DateTime
     */
    DateTime getLastEnd();
    void setLastEnd(DateTime lastEnd);
    
    /**
     * @return Timestamp of the last event processed
     */
    DateTime getLastEventDate();
    void setLastEventDate(DateTime lastEventDateTime);
}
